home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 005 / pal12.arc / PAL12.DOC < prev   
Text File  |  1985-12-28  |  10KB  |  234 lines
  1. DOCUMENTATION FOR PAL.COM   Ver. 1.2  June 7, 1985
  2.      Personal Appointment Locator for Sidekick
  3.      Sidekick is a product of Borland International
  4.  
  5.      PAL is copyright 1985  by Robert D. Tolz
  6.              110 Greene St.
  7.              New York, NY  10012
  8.              Compuserve [70475,1071]
  9.  
  10.      
  11.  
  12.  
  13. 1.   WHO CAN USE PAL?
  14.  
  15.      This version of PAL is usable only by owners of IBM-PC's and 
  16. compatibles who are users of the appointment calendar facility 
  17. provided in Sidekick.
  18.  
  19.  
  20.  
  21. 2.   WHAT DOES PAL DO?
  22.  
  23.      Features of PAL version 1.2 include the following:
  24.  
  25.      *  Search your appointment file to show all your 
  26. appointments within a specified range of days from today.
  27.  
  28.      *  Optionally send the report to the printer.
  29.  
  30.      *  Optionally send the report to a file.
  31.  
  32.      *  Search your appointment file for an appointment
  33.  
  34.      *  Maintain a reminder list
  35.  
  36.  
  37.  
  38.  
  39. 3.   WHAT IS THE BEST WAY TO USE PAL?
  40.  
  41.      In report mode, the best way has been to invoke PAL from my 
  42. autoexec.bat file after the date has been set.  This assures me 
  43. that as soon as I boot up, I will see all my appointments 
  44. automatically without having to call up Sidekick and search 
  45. manually through the appointment calendar.
  46.  
  47.      In search mode, I use PAL to search my entire appointment 
  48. file from beginning to end to locate a memo that matches the 
  49. string I supply.
  50.  
  51.  
  52.  
  53. 4.   HOW DO I USE PAL?
  54.  
  55.      A.   PAL syntax:
  56.  
  57.      PAL n{C,F,P} {Filename}               for Report Mode, or
  58.      PAL ${C,F,P} {SearchTerm} {Filename}  for Search Mode
  59.  
  60.      You ** must ** specify either of the mode selectors "n" or 
  61. "$" as the first term on the command line following "PAL", 
  62. otherwise you will get an error message and a help screen.
  63.  
  64.      B.   In Report Mode, "n" represents a positive integer 
  65. describing the number of days that you want PAL to scan, from and 
  66. including today's date.  You may follow "n" with one or more of 
  67. the three optional parameters.  After the optional parameters, 
  68. you may specify the name of the file you want to read.
  69.  
  70.      C.   In Search Mode, "$" signals PAL that the next following 
  71. term on the commandline is the string you want to match.  You may 
  72. follow "$" with one or more of the three optional parameters.  
  73. After the optional parameters, you ** must ** specify the 
  74. searchterm you wish to match.  After the searchterm, you may 
  75. specify the name of the file you want to search.
  76.  
  77.      D.   "C", "F" and "P" are optional parameters.  If you 
  78. choose any one or more of these parameters, they must be 
  79. specified immediately following the mode selectors "n" or "$", 
  80. without the presence of any intervening spaces.  If any spaces 
  81. follow your mode selector, then the next series of characters 
  82. will be taken by PAL to be the next term which it expects to see 
  83. on the command line.  The meaning of the optional parameters is 
  84. as follows.
  85.           
  86.                "C" turns off color.  By default, color 
  87.      is on if your monitor runs from a color card and 
  88.      off if you have a monochrome monitor running from a 
  89.      mono card.  Do not mistake "monochrome" for a black 
  90.      & white composite monitor hooked up to a color 
  91.      card.  If you have a black & white monitor running 
  92.      off a color card, then the characters are likely to 
  93.      be very difficult to read unless you use the "C" 
  94.      parameter.  "C" has no effect in monochrome 
  95.      systems.  If you have a color monitor, then use "C" 
  96.      at your discretion.
  97.  
  98.                "F" automatically sends the report to a 
  99.      file by the name of "PAL.TXT."  The entire output 
  100.      is capitalized.  This option may be useful to those 
  101.      who would like to use PAL.TXT in redirection, 
  102.      piping, or batch files.  When F is specified, the 
  103.      report is also produced on the screen, but the 
  104.      display does not pause when the screen fills.
  105.  
  106.                "P" sends the report to your printer.  
  107.      When P is specified, the report is also produced on 
  108.      the screen, but the display does not pause when the 
  109.      screen fills.
  110.  
  111.                {Note:  Version 1.1 of PAL contained a 
  112.      delete option.  This has been removed.  Sidekick was 
  113.      apparently becoming confused when an appointment file 
  114.      to which it was currently attached and which it held in 
  115.      memory was being changed by PAL.  The delete option 
  116.      will reappear in PAL whenever I can figure out a way to 
  117.      dispel Sidekick's confusion.}
  118.  
  119.      E.   "Filename" is an optional designation of the name of your 
  120. appointment file.  It must be separated from preceeding terms by at 
  121. least one space.  "Filename" must be a string giving the full 
  122. name of the appointment file you wish to scan; you may designate 
  123. the full subdirectory description if the file is not in the 
  124. default subdirectory.  If you do not supply a filename, then 
  125. PAL will assume that you are looking for "APPOINT.APP" in the 
  126. default subdirectory.  
  127.  
  128.      F.   "SearchTerm" is required in Search Mode.  SearchTerm is 
  129. any word or part of a word for which you would like to find a 
  130. match in your appointment file.  PAL does not care what case you 
  131. use for the characters of SearchTerm.  For instance, specifying 
  132. "PAL $ aS" will match and produce a report showing appointments 
  133. for "Baseball Game," "Lou Asner" or "!Ask for a raise".
  134.  
  135.  
  136.  
  137.  
  138. 5.  HOW DO I MAINTAIN A REMINDER LIST?
  139.  
  140.      All you have to do is enter your reminders with Sidekick, 
  141. making sure that the first character is "!".  From then on, 
  142. unless you physically delete that reminder with Sidekick, any 
  143. time you call up PAL in report mode, any reminders which were 
  144. entered for days prior to the current date will be displayedy 
  145. time you call up PAL in report mode, any reminders which were 
  146. entered for days prior to the current date will be displayed 
  147. following the regular report.
  148.  
  149.      For instance, let's say that on May 15, I open up my 
  150. appointment calendar to June 1 and enter (at any vacant slot) 
  151. "!Ask for raise."  If my autoexec.bat file includes "PAL 
  152. 3", then I will start seeing that reminder on May 30.  If I 
  153. procrastinate and fail to follow through on the reminder, then on 
  154. June 2 and thereafter, so long as I have not physically deleted 
  155. that reminder with Sidekick, I will continue to see it carried 
  156. forward and displayed whenever I call PAL in the report mode.
  157.  
  158.  
  159. 6.   EXAMPLES.
  160.  
  161.      PAL 7               gives a report for 7 days;
  162.      PAL 32000           gives a report for 32000 days;
  163.      PAL 7cPf            gives a report for 7 days, turns off 
  164.                          color, sends report to screen, printer,
  165.                          and (in all caps) to a file called 
  166.                          "Pal.Txt".  Note that the order of the 
  167.                          optional parameters and their case is
  168.                          insignificant.  The report to the screen
  169.                          will not pause when the screen is filled
  170.                          so long as the report is going to either
  171.                          the file or the printer.
  172.      PAL 7 \sk\appoint.app
  173.                          gives a 7 day report from the file 
  174.                          appoint.app found in subdirectory \sk.  
  175.                          All the prior examples assumed 
  176.                          appoint.app exists on the default drive.
  177.      PAL 7 \todolist     gives a 7 day report from a file in the
  178.                          root subdirectory with the name of 
  179.                          todolist
  180.      PAL $ bo            Searches appoint.app in the default 
  181.                          subdirectory for memos containing the
  182.                          string "bo".  You could also have
  183.                          typed "BO", "Bo", or "bO" without
  184.                          any difference in effect.  PAL will
  185.                          look for all permutations of upper-
  186.                          case/lower-case in your memos.
  187.  
  188.      PAL $ bo \sk\appoint.app
  189.                          Searches appoint.app in the \sk 
  190.                          subdirectory for memos containing the
  191.                          string "bo".
  192.  
  193.      PAL $ Henry Kissinger
  194.                          searches the file Kissinger located in
  195.                          the default subdirectory for memos
  196.                          containing the string "Henry".  Be
  197.                          careful:  your search string must be
  198.                          a single character or word.  Once
  199.                          PAL sees a blank, it presumes that the
  200.                          searchterm is finished and looks at
  201.                          the next word as the name of the file.     
  202.  
  203.  
  204.  
  205. 7.   WHAT IF I WANT TO SEE APPOINTMENTS FROM A RANGE THAT BEGINS 
  206. ON A DATE OTHER THAN TODAY?
  207.  
  208.      Sorry, there's no easy solution to that other than to use 
  209. the DATE command from DOS to change the current date, then run 
  210. PAL, then use the DATE command again to restore the correct date.  
  211. PAL will always look to the system date as the beginning of its 
  212. range.
  213.  
  214.  
  215.  
  216. 8.   WHAT WAS PAL PROGRAMMED IN?
  217.  
  218.      Turbo Pascal version 3, of course.
  219.  
  220.  
  221.  
  222. 9.   WHAT ABOUT BUGS, WISH LISTS, ETC.?
  223.      
  224.      Contact the author above.  I am anxious to hear your 
  225. comments and fix up any problems.  I would like to know how you 
  226. think PAL can be made more useful to you.
  227.  
  228.  
  229.  
  230.  
  231. 10.   DONATIONS:
  232.  
  233.      (as thanks for making PAL available and/or to encourage 
  234. further development) will not be rejected.  See address above.